/*
 * Copyright 2011 Subhabrata Ghosh <subho.ghosh at langene.net>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



package net.langene.nlp.model;

/**
 * This class encapsulates actions relations for
 * Entities.
 *
 * @author Subhabrata Ghosh <subho.ghosh at langene.net>
 */
public class Action {
    private EnumConnectorType	type;
    private Token		value;

    /**
     * Create a new Action instance with the specified Connector type
     * and Token value.
     *
     * @param type
     * @param value
     * @throws Exception
     */
    public Action(EnumConnectorType type, Token value) throws Exception {
        if (!isValidType(type)) {
            throw new Exception("Connection Type specified [" + type.name()
                                + " doesn't define an action.");
        }

        this.type  = type;
        this.value = value;
    }

    /**
     * Check if the specified Connector type defines an action.
     *
     * @param type Connector type.
     * @return true, if is attribute, else false.
     */
    public static boolean isValidType(EnumConnectorType type) {

        // @todo  Check the Connector types
        return false;
    }

    /**
     * @return the type
     */
    public EnumConnectorType getType() {
        return type;
    }

    /**
     * @return the value
     */
    public Token getValue() {
        return value;
    }
}


//~ Formatted by Jindent --- http://www.jindent.com
